##### ViserRemit

Cross Platform(Android & IOS) Ultimate Remittance Solution

- Created : 24 July 2024
- By : Viserlab
- Email : support@viserlab.com

Welcome to ViserRemit, your go-to professional remittance business solution now available on both Android and iOS platforms. This app has been designed exclusively for customers who have already purchased our "ViserRemit - Ultimate Remittance Solution" web application.

If you haven't already purchased the web app, please purchase it by clicking here.

> We are committed to improving the ViserRemit app by delivering regular updates, introducing new features, and prioritizing security to ensure a seamless experience for all our users. Your feedback is invaluable to us, and we're always open to hearing your suggestions.

Thank you for choosing ViserRemit for your remittance needs. If you have any questions or need assistance not covered in this document, please feel free to reach out to us via email. Our team is here to assist you promptly. We appreciate your trust and look forward to serving you.

##### Requirements

Follow the below requirements.

- Download and install Any one from these IDE(Android studio, Vs Code)
- Flutter and Dart must be successfully installed and setup on your device in order to edit this project.(Recommended Flutter SDK version: 3.13.6)
- Install the Flutter and Dart plugins after setting up your editor

##### Installation

Follow the below instruction to install the system.

- Unzip the downloaded project and open the project to the preferred IDE (Android Studio / Visual Code)
- Then complete the main configuration section
- On IDE go to the pubspecs.yaml file then clicks on the Pub Get button top of the IDE to install the libraries.
- To run the project, connect an emulator or a real device.
- Then press the Run button to run the project on the connected device

##### Folder Structure

Folders and files structure are showing below

- assets
  - fonts
  - images
- lib
  - core
    - di_service
    - helper
    - route
    - theme
    - utils
  - data
    - controller
    - model
    - repo
    - services
  - view
    - components
    - screens
  - main.dart
  - push_notification_service.dart
- pubspec.yaml

##### Screens

Our app screens list are showing below

- Splash Screen
- OnBoard Screen
- Login and Registration Screen
- Forget Password and Reset Password Screen
- Email, Sms Screen
- Kyc Screen
- Smart Homepage
- Currency Calculation
- Send Money Screen
- Paymant Screen
- Transaction History Screen
- Menu Screen
- Profile Edit Section
- Muti Language
- Change Password Screen
- And more...

##### Main Configuration

Application Setup

##### 1. Flutter Setup

Follow the guidelines in the following link to install the Flutter environment

OFFICIAL DOC LINK: https://docs.flutter.dev/get-started/install

##### 2. Firebase Setup

- Create a New Firebase Project:
  - Once you are logged in, click on the "Add Project" button
  - Provide a name for your Firebase project. This name is for your reference and can be anything you like.
  - Choose or Create a Google Analytics Account:

    If you enabled Google Analytics, you'll need to choose an existing Google Analytics account or create a new one.

  - Click on 'Create Project.'
  - Wait for Project Creation:

    Firebase will take a moment to create your project. Once it's done, you'll be redirected to the project dashboard.

  - Click on 'Continue'
- Cloud Cloud Messaging Server Key Setup
  - After Clicking On Settings Icon Click On Cloud Messaging
  - If Disable then click on 3 dot
  - Click Enable Button
  - Also You can Disable It
  - Then, go back to the previous Firebase settings page, and you will find the "Enabled" mark.
  - Click to Add Server Key
  - Done Now you can Copy Firebase Server Key And use it in Admin Panel

##### 2. Firebase setup with CLI

First go to you firebase project
- Click to Flutter Icon
- Now Click to Install Firebase Cli
- Now Click to Install Node JS
- Download Nodejs LTS version and Install Node JS
- Now Run npm install -g firebase-tools cmd in your terminal
- Next, install the FlutterFire CLI by running the following command:
CMD> dart pub global activate flutterfire_cli
- Now Setup Folder Path to environment variable:
- Copy Following folder path
- C:\Users\Your PC name\AppData\Local\Pub\Cache\bin
- Now Open Edit the system environment variable:
- Click On Environment Variable button
- Click On Path and click Edit button
- Click on New button and paste your Folder Path here and click OK button
- Now Again Go to your Firebase tab and click Next
- now go to your App Project Folder and run following Command
CMD 1 > dart pub global activate flutterfire_cli
CMD 2 > flutterfire configure --project=Your FirebaseProjec tName
- Now complete Following 1 and 2 steps
- When you run the second command, you will receive the data below. After that, you need to select your desired platform. Once the platform selection is complete, you have to press Enter.
- Congratulations you firebase setup in you app is successfully done

##### Setup

Application Setup

##### 1. Change App Name

- For Android
  - Open AndroidMainfest.xml to IDE from android/app/src/main
  - Change the label name inside the application tag from this file
- For IOS
  - Open Info.plist file to IDE from ios/Runner
  - Change the app name inside the dict. Please follow the below instruction.

##### 2. App Icon Change

- For Android
  - Go to /android/app/src/main/res and replace all mipmap folder with your generated icon android folder.
- For IOS
  - Go to /ios/Runner and replace Assets.xcassets with your generated Assets.xcassets folder.

Note: For different type of device we need to add different size of icon. So that you should to need to resize them. You can use https://appicon.co/ platform to generate multiple size icons for android and ios. It will provide you the icon with a correct folder structure.

##### 3. App Logo Change

- - Go to the AppFolder/assets/images/logo and replace it with your image

##### 4. Onboard Image Change

Image Change
- - Go to the AppFolder/assets/images/onboard and replace it with your image.

Text Change
- - Go to the AppFolder/lib/core/utils/my_strings.dart and replace it with your Own TEXT.

##### 5. API Base URL

- Open lib/core/utils/url_container.dart file and change base url string

##### 6. Change App Color

- Open lib/core/utils/my_color.dart folder and Replace the value in the primary Color field with the prepared color code. From here, you can easily change the color of something else.

##### 7. Change Package Name

- Right click on project folder and click on Replace in Files
- Search dev.vlab.viser_remit in the first indicated box and your own package name in the second marked box. Then click Replace All button

##### Publish App

Follow below instruction to publish the app

##### 1. Android

Follow the guidelines in the following link to publish the app to Play Store.

PlayStore: https://flutter.dev/docs/deployment/android

##### 2. IOS

Follow the guidelines in the following link to publish the app to AppStore.

AppStore: https://flutter.dev/docs/deployment/ios

##### Support

Support information details

Once again, thank you so much for purchasing this App. As I said at the beginning, I'd be glad to help you if you have any questions relating to this App. No guarantees, but I'll do my best to assist. If you have any queries, please feel free to contact us at Support Center.

Email Us: https://viserlab.com/support